'\" et
.TH MUNMAP "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
munmap
\(em unmap pages of memory
.SH SYNOPSIS
.LP
.nf
#include <sys/mman.h>
.P
int munmap(void *\fIaddr\fP, size_t \fIlen\fP);
.fi
.SH DESCRIPTION
The
\fImunmap\fR()
function shall remove any mappings for those entire pages containing
any part of the address space of the process starting at
.IR addr
and continuing for
.IR len
bytes. Further references to these pages shall result in the
generation of a SIGSEGV signal to the process.
If there are no mappings in the specified address range, then
\fImunmap\fR()
has no effect.
.P
The implementation may require that
.IR addr
be a multiple of the page size as returned by
\fIsysconf\fR().
.P
If a mapping to be removed was private, any modifications made in this
address range shall be discarded.
.P
Any memory locks (see
.IR "\fImlock\fR\^(\|)"
and
.IR "\fImlockall\fR\^(\|)")
associated with this address range shall be removed, as if by an
appropriate call to
\fImunlock\fR().
.P
If a mapping removed from a typed memory object causes the
corresponding address range of the memory pool to be inaccessible by
any process in the system except through allocatable mappings (that is,
mappings of typed memory objects opened with the
POSIX_TYPED_MEM_MAP_ALLOCATABLE flag), then that range of the memory
pool shall become deallocated and may become available to satisfy
future typed memory allocation requests.
.P
A mapping removed from a typed memory object opened with the
POSIX_TYPED_MEM_MAP_ALLOCATABLE flag shall not affect in any way the
availability of that typed memory for allocation.
.P
The behavior of this function is unspecified if the mapping was not
established by a call to
\fImmap\fR().
.SH "RETURN VALUE"
Upon successful completion,
\fImunmap\fR()
shall return 0; otherwise, it shall return \-1 and set
.IR errno
to indicate the error.
.SH ERRORS
The
\fImunmap\fR()
function shall fail if:
.TP
.BR EINVAL
Addresses in the range [\fIaddr\fP,\fIaddr\fP+\fIlen\fR) are outside
the valid range for the address space of a process.
.TP
.BR EINVAL
The
.IR len
argument is 0.
.P
The
\fImunmap\fR()
function may fail if:
.TP
.BR EINVAL
The
.IR addr
argument is not a multiple of the page size as returned by
\fIsysconf\fR().
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
The
\fImunmap\fR()
function corresponds to SVR4, just as the
\fImmap\fR()
function does.
.P
It is possible that an application has applied process memory locking
to a region that contains shared memory. If this has occurred, the
\fImunmap\fR()
call ignores those locks and, if necessary, causes those locks to be
removed.
.P
Most implementations require that
.IR addr
is a multiple of the page size as returned by
\fIsysconf\fR().
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fImlock\fR\^(\|)",
.IR "\fImlockall\fR\^(\|)",
.IR "\fImmap\fR\^(\|)",
.IR "\fIposix_typed_mem_open\fR\^(\|)",
.IR "\fIsysconf\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<sys_mman.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
